Automated Test: oauth-state-secure #321
Closed
+247
−50
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…#67876) We're adding one more step in the GitHub integration installation pipeline, namely GitHub OAuth2 authorize. This is transparent from the UX perspective as the data exchange happens without user interaction. The pipeline will now fail in these cases: - If there is a mismatch between currently authenticated GitHub user (derived from OAuth2 authorize step) and the user who installed the GitHub app (https://github.com/apps/sentry-io) - If there is a mismatch between `state` parameter supplied by user and pipeline signature - If GitHub could not generate correct `access_token` from the `code` (wrong or attempt of re-use of `code`). In all those cases, this error is shown: 
📝 WalkthroughWalkthroughThe changes introduce an OAuth login flow for GitHub integration with OAuthLoginView handling authentication, add centralized error rendering helpers, extend GitHubInstallation to manage state across pipeline steps, validate user-installation matching, and update get_pipeline_views to include the new OAuth view. Supporting tests validate the OAuth flow, edge cases, and repository retrieval functionality. Changes
Sequence DiagramsequenceDiagram
participant Client
participant Sentry as Sentry<br/>(OAuthLoginView)
participant GitHub as GitHub<br/>(OAuth)
participant Sentry2 as Sentry<br/>(Installation Flow)
Client->>Sentry: Initiate GitHub setup
Sentry->>Sentry: Get client credentials<br/>from GitHubIdentityProvider
Sentry->>Client: Redirect to GitHub auth<br/>with state parameter
Client->>GitHub: User authorizes
GitHub->>Client: Redirect with code & state
Client->>Sentry: Access callback with code & state
Sentry->>GitHub: Exchange code for<br/>access token
GitHub->>Sentry: Return access token
Sentry->>GitHub: Fetch authenticated<br/>user login
GitHub->>Sentry: Return user login
Sentry->>Sentry: Store in pipeline state
Sentry->>Sentry2: Pass to installation flow
Sentry2->>Sentry2: Validate authenticated user<br/>matches installation sender
Sentry2->>Sentry2: Store installation_id<br/>in state
Sentry2->>Client: Complete setup flow
Estimated code review effort🎯 4 (Complex) | ⏱️ ~50 minutes Poem
🚥 Pre-merge checks | ✅ 1 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (1 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches
🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@src/sentry/integrations/github/integration.py`:
- Around line 493-505: The code currently assumes
integration.metadata["sender"]["login"] exists and will KeyError for legacy
integrations; update the check in the handler that compares
pipeline.fetch_state("github_authenticated_user") to
integration.metadata["sender"]["login"] to first safely access metadata (e.g.,
validate that integration.metadata is a dict and contains "sender" with a
"login" key or use nested .get calls) and if the sender/login is missing call
error(request, self.active_organization) so the code fails cleanly; reference
the Integration instance (variable integration), pipeline.fetch_state(...) and
the error(...) return path when implementing the guard.
Comment on lines
+493
to
+505
| try: | ||
| integration = Integration.objects.get( | ||
| external_id=installation_id, status=ObjectStatus.ACTIVE | ||
| ) | ||
| except Integration.DoesNotExist: | ||
| return error(request, self.active_organization) | ||
|
|
||
| # Check that the authenticated GitHub user is the same as who installed the app. | ||
| if ( | ||
| pipeline.fetch_state("github_authenticated_user") | ||
| != integration.metadata["sender"]["login"] | ||
| ): | ||
| return error(request, self.active_organization) |
There was a problem hiding this comment.
Guard missing sender metadata to avoid runtime KeyError.
If legacy integrations lack metadata["sender"], the direct lookup will raise and surface a 500 instead of a clean failure.
🛠️ Suggested fix
- # Check that the authenticated GitHub user is the same as who installed the app.
- if (
- pipeline.fetch_state("github_authenticated_user")
- != integration.metadata["sender"]["login"]
- ):
- return error(request, self.active_organization)
+ sender_login = (integration.metadata.get("sender") or {}).get("login")
+ if not sender_login:
+ return error(request, self.active_organization)
+
+ # Check that the authenticated GitHub user is the same as who installed the app.
+ if pipeline.fetch_state("github_authenticated_user") != sender_login:
+ return error(request, self.active_organization)📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| try: | |
| integration = Integration.objects.get( | |
| external_id=installation_id, status=ObjectStatus.ACTIVE | |
| ) | |
| except Integration.DoesNotExist: | |
| return error(request, self.active_organization) | |
| # Check that the authenticated GitHub user is the same as who installed the app. | |
| if ( | |
| pipeline.fetch_state("github_authenticated_user") | |
| != integration.metadata["sender"]["login"] | |
| ): | |
| return error(request, self.active_organization) | |
| try: | |
| integration = Integration.objects.get( | |
| external_id=installation_id, status=ObjectStatus.ACTIVE | |
| ) | |
| except Integration.DoesNotExist: | |
| return error(request, self.active_organization) | |
| sender_login = (integration.metadata.get("sender") or {}).get("login") | |
| if not sender_login: | |
| return error(request, self.active_organization) | |
| # Check that the authenticated GitHub user is the same as who installed the app. | |
| if pipeline.fetch_state("github_authenticated_user") != sender_login: | |
| return error(request, self.active_organization) |
🤖 Prompt for AI Agents
In `@src/sentry/integrations/github/integration.py` around lines 493 - 505, The
code currently assumes integration.metadata["sender"]["login"] exists and will
KeyError for legacy integrations; update the check in the handler that compares
pipeline.fetch_state("github_authenticated_user") to
integration.metadata["sender"]["login"] to first safely access metadata (e.g.,
validate that integration.metadata is a dict and contains "sender" with a
"login" key or use nested .get calls) and if the sender/login is missing call
error(request, self.active_organization) so the code fails cleanly; reference
the Integration instance (variable integration), pipeline.fetch_state(...) and
the error(...) return path when implementing the guard.
Sign in
to join this conversation on GitHub.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request was automatically created by
@coderabbitai/e2e-reviewer.Batch created pull request.
Summary by CodeRabbit
New Features
Bug Fixes